ReadAxisFollowingError

Reads a following error from an axis.

Syntax

KsError ReadAxisFollowingError(
     int Index,
     int* Value
);

Parameters

Index: the index of an axis. Indexes are zero based. Aliases affect this parameter.

Value: pointer to the current value of the following error (the difference between the target and actual positions) to be written.

Return value

If the function succeeds, it returns errNoError, otherwise an error code. For more information about the error code, see the KsError list.

Remarks

Used in the cyclic callback to check the following error of an axis.

NOTE:  The following error is available only if EnableFollowingError is enabled.

Usable EtherCAT states

ecatOP

Example

Copy
int followingErrorRead = 0;
nRet = ReadAxisFollowingError(0, &followingErrorRead);

Requirements

  RT Win32
Minimum supported version 4.0 4.0
Header ksapi.h ksapi.h
Library KsApi_Rtss.lib KsApi.lib

See also

EnableFollowingError